<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: util/string_ostream.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_23ec12649285f9fabf3a6b7380226c28.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">string_ostream.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="string__ostream_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">flow/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;boost/iostreams/stream.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;boost/iostreams/stream_buffer.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;boost/iostreams/device/back_inserter.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1util.html">flow::util</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">/**</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * Similar to `ostringstream` but allows fast read-only access directly into the `std::string` being written;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * and some limited write access to that string.  Also it can take over an existing `std::string`.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * `ostringstream` is fine, except for the giant flaw that is the fact that the essentially only way to read the string</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * is to call `ostringstream::str()` which returns a copy, not a reference.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * @todo Consider using `alt_sstream` in boost.format; it doesn&#39;t seem to have public documentation but isn&#39;t in</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * a `detail` directory either.  So that&#39;s interesting.  It might have better performance than the implementation</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * here (by being more &quot;direct&quot; probably).  Then again it might not.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * This provides the same level of thread safety as `ostringstream`.  That is, you should use a mutex if planning</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * concurrent read/write access to the same object.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> */</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html">   45</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1util_1_1String__ostream.html">String_ostream</a> :</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>{</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"></span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   * Wraps either the given `std::string` or a newly created empty string if a null pointer is passed.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   *</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">   * @param target_str</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">   *        Pointer to the string of which to take ownership; null to use an internal string currently blank.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">   *        If non-null is passed, any subsequnt access to `*target_str` except via this class&#39;s API results in</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">   *        undefined behavior.  (It should go without saying, but using `const_cast` or equivalents counts as being</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">   *        outside the bounds of this class&#39;s API.)</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">   */</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1util_1_1String__ostream.html#a555fa9e2f764b9599fa7027f9d3a0051">String_ostream</a>(std::string* target_str = 0);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"></span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">   * Access to stream that will write to owned string.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">   *</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">   * @return Stream.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">   */</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>  std::ostream&amp; <a class="code hl_function" href="classflow_1_1util_1_1String__ostream.html#a7e64b069ae0e221952068c13fdc0f080">os</a>();</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"></span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * Read-only access to stream that will write to owned string.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * @return Read-only reference to stream.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   */</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="keyword">const</span> std::ostream&amp; <a class="code hl_function" href="classflow_1_1util_1_1String__ostream.html#a7e64b069ae0e221952068c13fdc0f080">os</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"></span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   * Read-only access to the string being wrapped.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   *</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   * The reference&#39;s value never changes for `*this` object.  The string&#39;s value may change, if one writes to</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * `os()` or does str_clear(), etc.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   * Why return `const string&amp;` instead of util::String_view?  Answer: By definition we are backed by an `std::string`,</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * either our own or one user actively passed to ctor.  Hence it&#39;s unnecessary obfuscation; plus it can lead to</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   * errors, like if the user thinks a returned object&#39;s `String_view::size()` will auto-adjust based on what happens</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * to the wrapped `std::string` subsequently.  If they want a `String_view`, they can always just construct one, just</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   * as we would inside here anyway.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   *</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   * @return Read-only reference to string; the address therein is guaranteed to always be the same given a `*this`.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   */</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>  <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classflow_1_1util_1_1String__ostream.html#aa7682e71a5e96955a52643e63bf97ad0">str</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"></span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   * Performs `std::string::clear()` on the object returned by `str()`.  The latter is `const`, so you may not</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   * call `clear()` directly.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   *</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   * @note `clear()` is a frequently desired operation, which is why access to it is provided as a special case.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *       It is intentional that no read-write version of str() is provided for arbitrary write operations.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   */</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1util_1_1String__ostream.html#a55008c2e651cfc832182a941284f7e7e">str_clear</a>();</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"></span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">  /// Short-hand for an `ostream` writing to which will append to an std::string it is adapting.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html#a6f12f8266343018c2025ebf61c586b6d">  108</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1util_1_1String__ostream.html#a6f12f8266343018c2025ebf61c586b6d">String_appender_ostream</a> = boost::iostreams::stream&lt;boost::iostreams::back_insert_device&lt;std::string&gt;&gt;;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"></span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * Underlying string to use if user chooses not to pass in their own in constructor.  Otherwise unused.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * (Could use `unique_ptr` to avoid even allocating it if not needed; but the memory use of an empty</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   * string is negligible, and this is otherwise equally fast or faster and leads to simpler code.)</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   */</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html#a0ac450344a0464a634f78288f6c357c8">  117</a></span>  std::string <a class="code hl_variable" href="classflow_1_1util_1_1String__ostream.html#a0ac450344a0464a634f78288f6c357c8">m_own_target_str</a>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"></span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">  /// Pointer to the target string.  Emptied at construction and in str_clear() *only*.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html#afa87f2303455e62c0be244deb37cb65e">  120</a></span><span class="comment"></span>  std::string* <a class="code hl_variable" href="classflow_1_1util_1_1String__ostream.html#afa87f2303455e62c0be244deb37cb65e">m_target</a>;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"></span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">  /// Inserter into #m_target.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html#ab8866da6531e449b80b1b7bb18a3b7b9">  123</a></span><span class="comment"></span>  boost::iostreams::back_insert_device&lt;std::string&gt; <a class="code hl_variable" href="classflow_1_1util_1_1String__ostream.html#ab8866da6531e449b80b1b7bb18a3b7b9">m_target_inserter</a>;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"></span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">  /// Appender `ostream` into #m_target by way of #m_target_inserter.  Write/`flush` here to write to #m_target.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classflow_1_1util_1_1String__ostream.html#abaf52be7b420f87d9a75edec7be2fc6b">  126</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classflow_1_1util_1_1String__ostream.html#a6f12f8266343018c2025ebf61c586b6d">String_appender_ostream</a> <a class="code hl_variable" href="classflow_1_1util_1_1String__ostream.html#abaf52be7b420f87d9a75edec7be2fc6b">m_target_appender_ostream</a>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>}; <span class="comment">// class String_ostream</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>} <span class="comment">// namespace flow::util</span></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html">flow::util::String_ostream</a></div><div class="ttdoc">Similar to ostringstream but allows fast read-only access directly into the std::string being written...</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00045">string_ostream.hpp:47</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_a0ac450344a0464a634f78288f6c357c8"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#a0ac450344a0464a634f78288f6c357c8">flow::util::String_ostream::m_own_target_str</a></div><div class="ttdeci">std::string m_own_target_str</div><div class="ttdoc">Underlying string to use if user chooses not to pass in their own in constructor.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00117">string_ostream.hpp:117</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_a55008c2e651cfc832182a941284f7e7e"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#a55008c2e651cfc832182a941284f7e7e">flow::util::String_ostream::str_clear</a></div><div class="ttdeci">void str_clear()</div><div class="ttdoc">Performs std::string::clear() on the object returned by str().</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8cpp_source.html#l00048">string_ostream.cpp:48</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_a555fa9e2f764b9599fa7027f9d3a0051"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#a555fa9e2f764b9599fa7027f9d3a0051">flow::util::String_ostream::String_ostream</a></div><div class="ttdeci">String_ostream(std::string *target_str=0)</div><div class="ttdoc">Wraps either the given std::string or a newly created empty string if a null pointer is passed.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8cpp_source.html#l00025">string_ostream.cpp:25</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_a6f12f8266343018c2025ebf61c586b6d"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#a6f12f8266343018c2025ebf61c586b6d">flow::util::String_ostream::String_appender_ostream</a></div><div class="ttdeci">boost::iostreams::stream&lt; boost::iostreams::back_insert_device&lt; std::string &gt; &gt; String_appender_ostream</div><div class="ttdoc">Short-hand for an ostream writing to which will append to an std::string it is adapting.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00108">string_ostream.hpp:108</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_a7e64b069ae0e221952068c13fdc0f080"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#a7e64b069ae0e221952068c13fdc0f080">flow::util::String_ostream::os</a></div><div class="ttdeci">std::ostream &amp; os()</div><div class="ttdoc">Access to stream that will write to owned string.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8cpp_source.html#l00033">string_ostream.cpp:33</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_aa7682e71a5e96955a52643e63bf97ad0"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#aa7682e71a5e96955a52643e63bf97ad0">flow::util::String_ostream::str</a></div><div class="ttdeci">const std::string &amp; str() const</div><div class="ttdoc">Read-only access to the string being wrapped.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8cpp_source.html#l00043">string_ostream.cpp:43</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_ab8866da6531e449b80b1b7bb18a3b7b9"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#ab8866da6531e449b80b1b7bb18a3b7b9">flow::util::String_ostream::m_target_inserter</a></div><div class="ttdeci">boost::iostreams::back_insert_device&lt; std::string &gt; m_target_inserter</div><div class="ttdoc">Inserter into m_target.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00123">string_ostream.hpp:123</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_abaf52be7b420f87d9a75edec7be2fc6b"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#abaf52be7b420f87d9a75edec7be2fc6b">flow::util::String_ostream::m_target_appender_ostream</a></div><div class="ttdeci">String_appender_ostream m_target_appender_ostream</div><div class="ttdoc">Appender ostream into m_target by way of m_target_inserter. Write/flush here to write to m_target.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00126">string_ostream.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1String__ostream_html_afa87f2303455e62c0be244deb37cb65e"><div class="ttname"><a href="classflow_1_1util_1_1String__ostream.html#afa87f2303455e62c0be244deb37cb65e">flow::util::String_ostream::m_target</a></div><div class="ttdeci">std::string * m_target</div><div class="ttdoc">Pointer to the target string. Emptied at construction and in str_clear() only.</div><div class="ttdef"><b>Definition:</b> <a href="string__ostream_8hpp_source.html#l00120">string_ostream.hpp:120</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html"><div class="ttname"><a href="namespaceflow_1_1util.html">flow::util</a></div><div class="ttdoc">Flow module containing miscellaneous general-use facilities that don't fit into any other Flow module...</div><div class="ttdef"><b>Definition:</b> <a href="basic__blob_8hpp_source.html#l00028">basic_blob.hpp:29</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
